home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 7 / Amiga Format AFCD07 (Dec 1996, Issue 91).iso / serious / shareware / misc / cpk / docs / babel.doc < prev    next >
Text File  |  1994-01-23  |  12KB  |  340 lines

  1.  
  2.           Babel version 1.03 Copyright (C) 1992,1993,1994
  3.                   by
  4.               Pat Walters and Matt Stahl
  5.  
  6.             Dolata Research Group
  7.                Department of Chemistry
  8.             University of Arizona
  9.                Tucson, AZ 85721
  10.            babel@mercury.aichem.arizona.edu
  11.  
  12.  
  13.  
  14.  
  15. This software is provided on an "as is" basis, and without warranty of any 
  16. kind, including but not limited to any implied warranty of merchantability 
  17. or fitness for a particular purpose.
  18.  
  19. In no event shall the authors or the University of Arizona be liable for 
  20. any direct, indirect, incidental, special, or consequential damages arising 
  21. from use or distribution of this software. The University of Arizona also 
  22. shall not be liable for any claim against any user of this program by any 
  23. third party.
  24.  
  25.  
  26. PLEASE REGISTER
  27.  
  28. We don't want any money for Babel (unless of course you insist), but we
  29. would like to know who has a copy so that we can notify people about updates 
  30. and bug fixes.
  31.  
  32. You can register by sending e-mail to babel@mercury.aichem.arizona.edu and 
  33. letting us know the following:
  34.     -who you are
  35.     -where you are
  36.     -what platform you're running Babel on
  37.     -which file conversions you commonly use
  38.  
  39. We are very open to suggestions.  If there's anything you like or don't 
  40. like about the program please let us know.  Also if there are file formats
  41. you would like to see supported let us know.
  42. --------------------------------------------------------------------------
  43.  
  44. Thanks for downloading this copy of babel.  With this program we hope to
  45. implement a general framework for converting between file formats used 
  46. for molecular modeling.  This is the first version of the manual, and 
  47. we are sorry to say that it's rather meager.  However, the program is very 
  48. easy to use and we're sure that by scanning over these few pages you'll
  49. be babbling away before you know it.   This manual is divided into 3 
  50. sections.
  51.  
  52. I. Installation
  53. II. Using Babel
  54. III. Other Stuff
  55.  
  56. I. INSTALLATION
  57. UNIX INSTALLATION
  58. Installation is very simple. 
  59.  
  60. 1. Special Instructions - Unless you have a Sun Workstaion with an old
  61. Sabre C compiler (or other non-ansi C compiler) or a Dec machine running
  62. Ultrix goto step 2.
  63.  
  64. SUN WORKSTATIONS WITH THE OLD (NON-ANSI) SABRE C COMPILER
  65. If you have a Sun workstation with the old Sabre C compiler or another
  66. non-ANSI C-compiler you must use gcc to compile babel. If you are using
  67. gcc to compile babel, change line 10 in the makefile from
  68.  
  69. CC          = cc
  70.  
  71. to
  72.  
  73. CC          = gcc
  74.  
  75. DEC STATIONS RUNNING ULTRIX - If you have gcc follow the instructions above
  76. to use gcc as the compiler.  Otherwise change line 1 in the Makefile from
  77.  
  78. CFLAGS        = -O 
  79.  
  80. to
  81.  
  82. CFLAGS        = -O -ULTRIX
  83.  
  84. 2. Make the program by typing make.
  85. 3. Set the environment variable BABEL_DIR to point to the directory 
  86. where the files types.lis and elements.lis are stored.
  87. i.e. If the files are in /usr/local/babel type the following
  88.  
  89. setenv BABEL_DIR /usr/local/babel
  90.  
  91. If you plan to use babel frequently then you will probably want to
  92. place the line above in your .cshrc file.
  93.  
  94.  
  95. II. USING BABEL
  96.  
  97. The babel program may be invoked using command line options or menus. 
  98.  
  99. The menu interface can be accessed by typing:
  100. babel -m
  101.  
  102. The command line input has the following format:
  103. babel [-v] -i<itype> <infile> [keywords] -o<out type> <outfile> [keywords2]
  104.  
  105. All arguments surrounded by [] are optional.
  106. The -v flag is optional and is used to produce verbose output.
  107. The -i flag is used to set the input type.  The following input type codes
  108. are currently supported.
  109.  
  110.     ac -- Mopac Cartesian file
  111.     ao -- Mopac Output file
  112.     ai -- Mopac Internal file
  113.     c -- CSD GSTAT file
  114.     cf -- CSD CSSR file
  115.     f -- Free Form Fractional file
  116.     k -- Macromodel file
  117.     micro -- Micro World file
  118.     mo -- MM2 Ouput file
  119.     p -- PDB file
  120.     t -- Alchemy file
  121.     x -- XYZ file
  122.     prep -- AMBER PREP file
  123.     molin -- MOLIN file
  124.     boog -- Boogie file
  125.     caccrt -- Cacao Cartesian file
  126.     macmol -- Mac Molecule file
  127.     c3d1 -- Chem 3D Cartesian 1 file
  128.     c3d2 -- Chem 3D Cartesian 2 file
  129.     bs -- Ball and Stick file
  130.     g -- Gaussian Z-Matrix file
  131.     gauout -- Gaussian Output file
  132.     gamout -- GAMESS Output file
  133.     mmads -- MMADS file
  134.     shelx -- ShelX file
  135.     mol2 -- Sybyl Mol2 file
  136.     fdat -- CSD FDAT file
  137.     charmm -- CHARMm file
  138.     mdl -- MDL Molfile file
  139.  
  140. The -o flag is used to set the output file type.  The following output 
  141. type codes are currently supported.
  142.  
  143.     diag -- DIAGNOTICS file
  144.     ac -- Mopac Cartesian file
  145.     ai -- Mopac Internal file
  146.     g -- Gaussian Z-matrix file
  147.     gcart -- Gaussian Cartesian file
  148.     i -- IDATM file
  149.     k -- Macromodel file
  150.     macmol -- Mac Molecule file
  151.     micro -- Micro World file
  152.     mi -- MM2 Input file
  153.     mo -- MM2 Ouput file
  154.     p -- PDB file
  155.     report -- Report file
  156.     t -- Alchemy file
  157.     caccrt -- Cacao Cartesian file
  158.     x -- XYZ file
  159.     bs -- Ball and Stick file
  160.     c3d1 -- Chem 3D Cartesian 1 file
  161.     c3d2 -- Chem 3D Cartesian 2 file
  162.     d -- ChemDraw Connection Table file
  163.     mdl -- MDL Molfile file
  164.     gamin -- Gamess Input file
  165.     mmads -- MMADS file
  166.     mol2 -- Sybyl Mol2 file
  167.  
  168. To convert an MM2 output file named mm2.grf to a MOPAC internal coordinate 
  169. input file named mopac.dat the user would enter:
  170. babel -imo mm2.grf -oai mopac.dat
  171.  
  172. To perform the above conversion with the keywords PM3 GEO-OK T=30000 in the
  173. file mopac.dat the user would enter:
  174. babel -imo mm2.grf -oai mopac.dat "PM3 GEO-OK T=30000"
  175. Note the use of the double quotes around the keywords.
  176.  
  177. HYDROGEN ADDITION/DELETION
  178. Babel has the ability to add and delete hydrogens from any file format.  
  179. Hydrogens can be added by supplying the -h flag, hydrogens may be deleted 
  180. by supplying the -d flag.
  181.  
  182. To add hydrogens a CSD fractional coordinate file called input.cssr and 
  183. output the file as a MOPAC internal coordinate input file named output.add 
  184. the user would type:
  185. babel -icf input.cssr -h -oai output.add 
  186.  
  187. To delete hydrogens from a Macromodel file named benzene.dat and 
  188. output the file as an XYZ file name benzene.new the user would type
  189. babel -ik benzene.dat -d -ox benzene.new
  190.  
  191. MULTI-STRUCTURE FILES
  192. Babel will currently read multi-structure files produced by Macromodel.  
  193. With this type of file the user has two output options
  194.     - produce one output file for each structure in the file
  195.     - produce a multi-structure output file.
  196.  
  197. When converting a multi structure file it is necessary to supply a 
  198. keyword after the input file name.  This keyword specifies the number
  199. of files to extract from the iput file.  The keyword can be either a 
  200. number or the word all.  Hopefully the examples below will make this
  201. a little more clear.
  202.  
  203. To extract all the structures from a multi-structure Macromodel file 
  204. called mols.out and write the structures as pdb files the user would 
  205. type:
  206.  
  207. babel -ik mols.out all -op mols.pdb
  208. The output files would be written as mols1.pdb, mols2.pdb, etc.
  209.  
  210. To extract only the first five structures from a multi-structure 
  211. Macromodel file and write the structures as mopac internal coordinate
  212. file the user would type
  213. babel -ik mols.out 5 -oai mols.int
  214. The output files would be written as mols1.int, mols2.int. etc.
  215.  
  216. It is sometimes necessary to convert a mulit-structure Macromodel file
  217. into a multi-structure file of another type.  This can be a handy way of
  218. viewing Macromodel movies with the Xmol program.  Babel accomplishes 
  219. this by sending the output to the console using the output file name
  220. CON (note the use of uppercase letters).  Once again this is better 
  221. explained by an example.  To convert all the structures in a 
  222. multi-structure Macromodel file called mols.out to a multi-structure XYZ 
  223. file called mols.xyz the user would type:
  224. babel -ik mols.out all -ox CON > mols.xyz
  225.  
  226. MACMOLECULE FILES
  227. Since MacMolecule only uses single letter it is often necessary to use
  228. different names (i.e. X for Cl).  The user can specify substituted atom
  229. names on the command line.  
  230.  
  231. To read a MacMolecule file named foo.bar where X is substituted for Cl
  232. and Y is substitued for Cobalt and write an MM2 output type file named
  233. bar.baz the user would type:
  234. babel -imacmol "X/Cl Y/Co" foo.bar -omo bar.baz  
  235.  
  236. CHEMDRAW FILES
  237. The user can supply a keyword to indicate the viewing axis for the 
  238. ChemDraw projection by supplying a keyword.  To convert an XYZ file
  239. named test.xyz to a ChemDraw file named test.cdy with the view down the
  240. y axis the user would type:
  241. babel -ix test.xyz -od test.cdx x
  242.  
  243. The default view is down the z axis.  Babel will also write MDL Molfile
  244. type files which can be read by ChemDraw, ChemIntosh, ChemWindow, and 
  245. Chem3D.
  246.  
  247. GAMESS FILES
  248. ---GAMESS Output Files---
  249. The output files are the .log files created by redirecting screen output.  
  250. Babel first looks for a set of geometry optimized coordinates.  If the 
  251. output file does not contain geometry optimized coordiantes Babel will 
  252. use the input coordiantes. If Babel uses the input coordiantes it will 
  253. convert from Bohr to Angstroms.
  254.  
  255. To read a GAMESS output file named exam01.log and convert it to an XYZ 
  256. file named exam01.xyz the user would type:
  257. babel -igamout exam01.log -ox exam01.xyz
  258.  
  259. ---GAMESS Input Files---
  260. Babel is capable of creating three types of GAMESS input files
  261. COORD=CART Cartesian Coordinates
  262. COORD=ZMAT Gaussian Style Z-matrix
  263. COORD=ZMTPC MOPAC Style Z-matrix
  264.  
  265. Babel does not calculate the point group for you.  You'll have to pull
  266. out your copy of Cotton and insert that manually. You'll also have to 
  267. specify your own $SYSTEM, $BASIS, $SCF, $GUESS, etc. cards.
  268.  
  269. The type of input file is controlled by specifying a keyword on the 
  270. Babel command line.  The keywords are
  271.     cart - Cartesian 
  272.     zmt - Gaussian style Z-matrix
  273.     zmtmpc - MOPAC style Z-matrix
  274.  
  275. To read an xyz file named coords.xyz and convert it to a GAMESS input
  276. file in Cartesian coordiantes named coords.in the user would type:
  277. babel -ix coords.xzy -ogamin coords.in cart
  278.  
  279. To do the same conversion by have the GAMESS input in Gaussian Z-matrix
  280. style the user would type
  281. babel -ix coords.xzy -ogamin coords.in zmt
  282.  
  283. If no keyword is specified the input file will be in Cartesian Coordiantes.
  284.  
  285.  
  286. III. OTHER STUFF
  287. CURRENT LIMITATIONS
  288. Macromodel - bond orders are not always correctly assigned for conjugated
  289. pi systems.  
  290.  
  291. PDB files - When reading PDB files Babel assigns bonds are examining 
  292. interatomic distances and assigning a bond where the interatomic distance
  293. is less than the sum of the atoms convalent radii.  There is code in read_pdb.c
  294. to read connections specified in CONECT records, but this code is commented
  295. out.  We did this because a number of files available from Brookhaven have
  296. CONECT records specified for only a few of the bonds in the molecule.  We
  297. realize that we could determine connectivity in the PDB file by looking
  298. at atom ids and residue types, but we have put this in yet.  This feature 
  299. will probably be added soon.  If you would like to use the explicit CONECT
  300. records in a PDB file see Appendix A.  When writing PDB files all residue
  301. types are assigned as UNK.
  302.  
  303. REPORTING BUGS
  304. Noone is perfect, and we're sure that there are still a few glitches in this
  305. program.  If you happen to find such a glitch please send a mail message to
  306. babel@mercury.aichem.arizona.edu describing the nature of the problem.  If 
  307. possible please include the input file so we can use it to determine the 
  308. cause of the problem.
  309.  
  310. CREDIT WHERE CREDIT IS DUE
  311. Bable began it's life a program called convert written by Ajay Shah.  
  312. Babel in its current form was written by Pat Walters with some help 
  313. from Matt Stahl.
  314.  
  315. COMING ATTRACTIONS
  316. We consider Babel to be a constantly evolving program.  Hopefully 
  317. modules to handle new file formats will be contributed and the program 
  318. will become useful to an even wider range of chemists.  We currently have 
  319. a number of additions to Babel underway at the
  320. U of A.  Among these are:
  321. 1.  A real users manual 
  322. 2.  A developers guide which will assist programmers in creating new 
  323. modules (Actually I have finished a draft of the Babel Developers Guide.
  324. If you'd like a copy send me some mail - pat@mercury.aichem.arizona.edu).
  325.  
  326. PLEASE WRITE
  327. We would really appreciate any and all input from babel users.  Please
  328. send comments, praise, flames, and job offers :-) to 
  329. babel@mercury.aichem.arizona.edu
  330.  
  331. Have fun,
  332.  
  333. Pat Walters
  334. Chief Cook and Bottle-Washer
  335.  
  336.  
  337.  
  338.  
  339.  
  340.